UpdateDiscount
The UpdateDiscount web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to update an existing active Discount for a given Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription, Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. or Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated. number.
This Service should be used in conjunction with the DISCOUNTS subset of the following services:
The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid identifier for the Level of the Hierarchy (Group, Corporate, Account, Subscription, Agreement), Discount Code, and Effective Date in order to update the Discount details.
Users are only able to pass in an expiry date as an editable parameter for the discount scheme.
Invalid requests are rejected with an error message.
UpdateDiscount Request
The UpdateDiscount request instructs the Billing Service to update Discount details. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
TargetIdentifier |
Container |
SubscriptionIdentifier (Integer8) |
Mandatory |
|
DiscountSchemeCode |
String6 |
The unique code for the Discount Scheme. |
Mandatory |
|
EffectiveDate |
Date |
The date from which the Discount is effective. YYYY-MM-DDZ |
Mandatory |
|
DiscountUpdateBasic |
Container |
See DiscountUpdateBasic Request Container for details. |
Optional |
DiscountUpdateBasic Request Container
The DiscountUpdateBasic request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExpiryDate |
Date |
The date on which the Discount is to expire. YYYY-MM-DDZ |
Mandatory |
|
LastAmendedDate |
dateTime |
YYYY-MM-DDThh:mm:ssZ |
Mandatory |
UpdateDiscount Response
The UpdateDiscount response is the response to the UpdateDiscountDetails Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |